chore: improvement hexo.extend #5209

dimaslanjaka · 2023-05-18T04:52:06Z

What does it do?

244be2f fix(TS2345): Argument of type 'string | Buffer' is not assignable to parameter of type 'string'.
a5aef69 fix: conditional of data is actually an object
- chore: add Pattern result boolean type
- NEED PR chore: some improvement as description hexo-util#311
  - changes hexojs/hexo-util@9ddb7e2
- ~~OR temporarily install my custom hexo-util.~~
  - ~~npm i hexo-util@https://github.com/dimaslanjaka/hexo/raw/1d4d41d/releases/hexo-util.tgz~~
  - ~~See all improved tarballs https://github.com/dimaslanjaka/hexo/tree/monorepo-v7/releases~~
~~b33d7e7 chore: moved interfaces to renderer-d.ts~~ already merged on hexojs/master
using ES Export style to easily import between source files
- chore(Renderer.register): add overload method types
- docs: add JSDoc
1ab1d58 feat(Filter.register): add overload method types
- fix(lint): eslint --fix
f2e17aa chore(StoreFunction): add explicit this marked as internal hexo function
- fix(lint): eslint --fix
31ef314 chore: convert interface TagFunction to overload type
- chore: convert interface AsyncTagFunction to overload type
- docs: add some JSDoc
- chore(coverage): add prefix _ to unused variables
- feat: add interface RegisterAsyncOptions
- fix: missing types feat(Tag.register): add overload types and JSDoc
- sample callback with single parameter https://github.com/hexojs/hexo-tag-embed/blob/0e9467d55a2dd746e97fafe5e1d255fc490e5ea7/lib/tags/vimeo.ts#L9-L20
4a61ca5 fix: cast pattern as StoreFunction
- fix: conditional when fn is not function
6aee1f3 chore: add missing type param ctx
1a11ad5 chore: change old type object to `Record<string, any>
cc9518b feat: add data type before_post_render
chore(hexo.loadPlugin): make callback as optional & add JSDoc
sample without callback https://github.com/hexojs/hexo/blob/8b95bbc722e5c77a7e8125441ed64d2ea3524ac0/test/scripts/tags/blockquote.js#LL8C16-L8C96
feat: add context interface ExtendedTagProperty
- chore: cast tag function callback as custom context
  useful for determining which post or page source the tag processor is currently processing from. see sample https://github.com/dimaslanjaka/hexo-shortcodes/blob/8224f992eee8a221db15996823e6d80e84a13ca1/src/include_file.ts#L55-L56

Demo

hexo.extend.tag hotfixed for typescript. see https://github.com/dimaslanjaka/hexo-shortcodes

Pull request tasks

Add test cases for the changes.
Passed the CI test.

- StoreFunction & StoreSyncFunction & StoreFunctionData - SyncStore & Store to easily import the interfaces between `extend` source files

fix: conditional when `fn` is not function

chore: convert interface `AsyncTagFunction` to overload type docs: add some JSDoc chore: add prefix `_` to unused variables feat: add interface `RegisterAsyncOptions` fix: missing types feat(Tag.register): add overload types and JSDoc

marked as internal hexo function fix(lint): eslint --fix

fix(lint): eslint --fix

to easily import between source files chore(Renderer.register): add overload method types docs: add JSDoc

chore: add `Pattern` result `boolean` type - PR hexojs/hexo-util/pull/311 - changes hexojs/hexo-util@9ddb7e2

…parameter of type 'string'.

github-actions · 2023-05-18T04:52:19Z

How to test

git clone -b v7-fix-extend https://github.com/dimaslanjaka/hexo.git
cd hexo
npm install
npm test

sample without callback https://github.com/hexojs/hexo/blob/8b95bbc722e5c77a7e8125441ed64d2ea3524ac0/test/scripts/tags/blockquote.js#LL8C16-L8C96

chore: cast tag function callback as custom context useful for determining which post or page source the tag processor is currently processing from

lib/extend/renderer.ts

SukkaW · 2023-05-19T14:30:09Z

lib/extend/renderer.ts

+  /**
+   * register renderer engine
+   * - [hexo-renderer-nunjucks example](https://github.com/hexojs/hexo-renderer-nunjucks/blob/c71a1979535c47c3949ff6bf3a85691641841e12/lib/renderer.js#L55-L56)
+   * - [typescript example](https://github.com/dimaslanjaka/hexo-renderers/blob/feed801e90920bea8a5e7000b275b912e4ef6c43/src/renderer-sass.ts#L37-L38)
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer function
+   */


Is it possible to reduce/dedupe the comment here?

Is it possible to reduce/dedupe the comment here?

yes, or should we using shortlink from http://bit.ly to reduce comment length ?

lib/plugins/filter/before_post_render/index.ts

SukkaW · 2023-05-19T14:35:17Z

lib/plugins/filter/template_locals/i18n.ts

+    if (
+      typeof data !== 'undefined'
+      && !Array.isArray(data)
+      && typeof data !== 'boolean'
+      && data.lang
+      && i18nLanguages.includes(data.lang)
+    ) {


This is somewhat over-complicated for a simple type guard. Is it possible to simplify it?

This is somewhat over-complicated for a simple type guard. Is it possible to simplify it?

because there has 3 return type (boolean | RegExpMatchArray | Record<string, unknown>)
see hexojs/hexo-util@e0719fb one of PR hexojs/hexo-util#311

see boolean return conflict

https://github.com/dimaslanjaka/hexo/blob/4ba63bc65d05d231fd1db1053013e2ae71661a70/lib/plugins/processor/common.ts#L29-L32

https://github.com/dimaslanjaka/hexo/blob/4ba63bc65d05d231fd1db1053013e2ae71661a70/lib/theme/processors/source.ts#L25-L32

ive tried:

when only validate (data), ts throw error property lang does not exist on Array type

when only validate !Array.isArray(data), ts throw error property lang does not exist on boolean type

when only validate typeof data === 'object' both errors above will occurs, because Array is also type object

typescript angry without strict validation :(

if there is any other suggestion, maybe it can be simplified without breaking (throw) during npm run build

or. enable explicit any, down level iterator, and moved all export as ES Export style. might it can used square bracket (data['page']) to suppress error validation during npm run build

sample supress syntax https://github.com/dimaslanjaka/static-blog-generator/blob/8cf940f1f7141085c42da874417c3d1a0cecf280/packages/sbg-utility/src/utils/scheduler.ts#L127

but these syntax style unsupported by hexo eslint config, it should be automatically fixed (moved to dots property style - data.page) on commit.

prevent indexed as source by VSCode, Intellij IDEA, Sublime Text v3 Co-authored-by: Sukka <[email protected]>

Co-authored-by: Sukka <[email protected]>

… type

github-actions · 2024-02-14T17:45:19Z

How to test

git clone -b v7-fix-extend https://github.com/dimaslanjaka/hexo.git
cd hexo
npm install
npm test

github-actions · 2024-02-14T17:46:38Z

flamegraph

https://97067108332434d15b3a30c14240ba8b5c3b474e-14-hexo.surge.sh/flamegraph.html
https://97067108332434d15b3a30c14240ba8b5c3b474e-16-hexo.surge.sh/flamegraph.html
https://97067108332434d15b3a30c14240ba8b5c3b474e-18-hexo.surge.sh/flamegraph.html

dimaslanjaka added 12 commits May 18, 2023 11:01

chore: moved interfaces and using ES Export style

8f6e1a6

- StoreFunction & StoreSyncFunction & StoreFunctionData - SyncStore & Store to easily import the interfaces between `extend` source files

feat: add data type before_post_render

cc9518b

chore: change old type object to `Record<string, any>

1a11ad5

chore: add missing type param ctx

6aee1f3

fix: cast pattern as StoreFunction

4a61ca5

fix: conditional when `fn` is not function

chore(lint): eslint --fix

83aa298

chore(StoreFunction): add explicit this

f2e17aa

marked as internal hexo function fix(lint): eslint --fix

feat(Filter.register): add overload method types

1ab1d58

fix(lint): eslint --fix

chore: moved interfaces to renderer-d.ts using ES Export style

b33d7e7

to easily import between source files chore(Renderer.register): add overload method types docs: add JSDoc

fix: conditional of data is actually an object

a5aef69

chore: add `Pattern` result `boolean` type - PR hexojs/hexo-util/pull/311 - changes hexojs/hexo-util@9ddb7e2

fix(TS2345): Argument of type 'string | Buffer' is not assignable to …

244be2f

…parameter of type 'string'.

dimaslanjaka changed the title ~~V7 fix extend~~ chore: improvement hexo.extend May 18, 2023

dimaslanjaka added 2 commits May 19, 2023 14:53

chore(hexo.loadPlugin): make callback as optional

b1312fc

sample without callback https://github.com/hexojs/hexo/blob/8b95bbc722e5c77a7e8125441ed64d2ea3524ac0/test/scripts/tags/blockquote.js#LL8C16-L8C96

feat(loadPlugin): add JSDoc

cfd7acb

dimaslanjaka mentioned this pull request May 19, 2023

chore: some improvement as description hexojs/hexo-util#311

Closed

feat: add context interface ExtendedTagProperty

1e572c8

chore: cast tag function callback as custom context useful for determining which post or page source the tag processor is currently processing from

SukkaW reviewed May 19, 2023

View reviewed changes

lib/extend/renderer.ts Outdated Show resolved Hide resolved

SukkaW reviewed May 19, 2023

View reviewed changes

lib/plugins/filter/before_post_render/index.ts Outdated Show resolved Hide resolved

SukkaW reviewed May 19, 2023

View reviewed changes

dimaslanjaka and others added 2 commits May 20, 2023 02:36

chore: export as type

28a2e1f

prevent indexed as source by VSCode, Intellij IDEA, Sublime Text v3 Co-authored-by: Sukka <[email protected]>

chore: update context type import

eeaacce

Co-authored-by: Sukka <[email protected]>

stevenjoezhang changed the base branch from v7.0.0 to master October 25, 2023 05:02

dimaslanjaka added 3 commits February 15, 2024 00:41

chore: merge from hexojs/hexo master

3c5ee1f

fix(TS2322): Type 'unknown' is not assignable to type 'string'.

e1fd7d7

feat(deps-dev): install @types/connect for middleware hexo-server…

e36d024

… type

chore: import hexo from parent folder

233dcb7

dimaslanjaka closed this Oct 3, 2024

dimaslanjaka deleted the v7-fix-extend branch October 3, 2024 08:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: improvement hexo.extend #5209

chore: improvement hexo.extend #5209

dimaslanjaka commented May 18, 2023 •

edited

Loading

github-actions bot commented May 18, 2023

SukkaW May 19, 2023

dimaslanjaka May 19, 2023

SukkaW May 19, 2023

dimaslanjaka May 19, 2023 •

edited

Loading

dimaslanjaka May 19, 2023

dimaslanjaka May 19, 2023

dimaslanjaka May 19, 2023

github-actions bot commented Feb 14, 2024

github-actions bot commented Feb 14, 2024 •

edited

Loading

chore: improvement hexo.extend #5209

chore: improvement hexo.extend #5209

Conversation

dimaslanjaka commented May 18, 2023 • edited Loading

What does it do?

Demo

Pull request tasks

github-actions bot commented May 18, 2023

How to test

SukkaW May 19, 2023

Choose a reason for hiding this comment

dimaslanjaka May 19, 2023

Choose a reason for hiding this comment

SukkaW May 19, 2023

Choose a reason for hiding this comment

dimaslanjaka May 19, 2023 • edited Loading

Choose a reason for hiding this comment

dimaslanjaka May 19, 2023

Choose a reason for hiding this comment

dimaslanjaka May 19, 2023

Choose a reason for hiding this comment

dimaslanjaka May 19, 2023

Choose a reason for hiding this comment

github-actions bot commented Feb 14, 2024

How to test

github-actions bot commented Feb 14, 2024 • edited Loading

flamegraph

dimaslanjaka commented May 18, 2023 •

edited

Loading

dimaslanjaka May 19, 2023 •

edited

Loading

github-actions bot commented Feb 14, 2024 •

edited

Loading